<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uartlite: xuartlite.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">uartlite
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xuartlite_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xuartlite.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_lite___stats.html">XUartLite_Stats</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Statistics for the <a class="el" href="struct_x_uart_lite.html" title="The XUartLite driver instance data. ">XUartLite</a> driver.  <a href="struct_x_uart_lite___stats.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_lite___buffer.html">XUartLite_Buffer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following data type is used to manage the buffers that are handled when sending and receiving data in the interrupt mode.  <a href="struct_x_uart_lite___buffer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_lite___config.html">XUartLite_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the device.  <a href="struct_x_uart_lite___config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_lite.html">XUartLite</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_uart_lite.html" title="The XUartLite driver instance data. ">XUartLite</a> driver instance data.  <a href="struct_x_uart_lite.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga516b36e319627a8a53a5b10b3f8fb62f"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga516b36e319627a8a53a5b10b3f8fb62f">XUartLite_Handler</a>) (void *CallBackRef, unsigned int ByteCount)</td></tr>
<tr class="memdesc:ga516b36e319627a8a53a5b10b3f8fb62f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function.  <a href="group__uartlite__v3__1.html#ga516b36e319627a8a53a5b10b3f8fb62f">More...</a><br /></td></tr>
<tr class="separator:ga516b36e319627a8a53a5b10b3f8fb62f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacf1026cbafbd78e1f3a7fd0ee433d001"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gacf1026cbafbd78e1f3a7fd0ee433d001">XUartLite_Initialize</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:gacf1026cbafbd78e1f3a7fd0ee433d001"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a <a class="el" href="struct_x_uart_lite.html" title="The XUartLite driver instance data. ">XUartLite</a> instance.  <a href="group__uartlite__v3__1.html#gacf1026cbafbd78e1f3a7fd0ee433d001">More...</a><br /></td></tr>
<tr class="separator:gacf1026cbafbd78e1f3a7fd0ee433d001"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf61ea88e001e95175590cb5b221a18d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gaaf61ea88e001e95175590cb5b221a18d">XUartLite_CfgInitialize</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, <a class="el" href="struct_x_uart_lite___config.html">XUartLite_Config</a> *Config, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gaaf61ea88e001e95175590cb5b221a18d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a <a class="el" href="struct_x_uart_lite.html" title="The XUartLite driver instance data. ">XUartLite</a> instance.  <a href="group__uartlite__v3__1.html#gaaf61ea88e001e95175590cb5b221a18d">More...</a><br /></td></tr>
<tr class="separator:gaaf61ea88e001e95175590cb5b221a18d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7932155bf2bc603fc0a972f5aefec77e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga7932155bf2bc603fc0a972f5aefec77e">XUartLite_ResetFifos</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7932155bf2bc603fc0a972f5aefec77e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the FIFOs, both transmit and receive, of the UART such that they are emptied.  <a href="group__uartlite__v3__1.html#ga7932155bf2bc603fc0a972f5aefec77e">More...</a><br /></td></tr>
<tr class="separator:ga7932155bf2bc603fc0a972f5aefec77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd990348cf8483d47934d3263dc6fe90"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gacd990348cf8483d47934d3263dc6fe90">XUartLite_Send</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, u8 *DataBufferPtr, unsigned int NumBytes)</td></tr>
<tr class="memdesc:gacd990348cf8483d47934d3263dc6fe90"><td class="mdescLeft">&#160;</td><td class="mdescRight">This functions sends the specified buffer of data using the UART in either polled or interrupt driven modes.  <a href="group__uartlite__v3__1.html#gacd990348cf8483d47934d3263dc6fe90">More...</a><br /></td></tr>
<tr class="separator:gacd990348cf8483d47934d3263dc6fe90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa30ed8bfedba1acdc67dc94e77d5a41d"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gaa30ed8bfedba1acdc67dc94e77d5a41d">XUartLite_Recv</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, u8 *DataBufferPtr, unsigned int NumBytes)</td></tr>
<tr class="memdesc:gaa30ed8bfedba1acdc67dc94e77d5a41d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will attempt to receive a specified number of bytes of data from the UART and store it into the specified buffer.  <a href="group__uartlite__v3__1.html#gaa30ed8bfedba1acdc67dc94e77d5a41d">More...</a><br /></td></tr>
<tr class="separator:gaa30ed8bfedba1acdc67dc94e77d5a41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga40bc490d296a7a929f1cc5d07bb29b3c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga40bc490d296a7a929f1cc5d07bb29b3c">XUartLite_IsSending</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga40bc490d296a7a929f1cc5d07bb29b3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function determines if the specified UART is sending data.  <a href="group__uartlite__v3__1.html#ga40bc490d296a7a929f1cc5d07bb29b3c">More...</a><br /></td></tr>
<tr class="separator:ga40bc490d296a7a929f1cc5d07bb29b3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga081d00a44aeebe19ed77e195a063b4e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga081d00a44aeebe19ed77e195a063b4e1">XUartLite_GetStats</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, <a class="el" href="struct_x_uart_lite___stats.html">XUartLite_Stats</a> *StatsPtr)</td></tr>
<tr class="memdesc:ga081d00a44aeebe19ed77e195a063b4e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a snapshot of the current statistics in the structure specified.  <a href="group__uartlite__v3__1.html#ga081d00a44aeebe19ed77e195a063b4e1">More...</a><br /></td></tr>
<tr class="separator:ga081d00a44aeebe19ed77e195a063b4e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33651bc4c0c36496d86038d95f39f0cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga33651bc4c0c36496d86038d95f39f0cd">XUartLite_ClearStats</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga33651bc4c0c36496d86038d95f39f0cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function zeros the statistics for the given instance.  <a href="group__uartlite__v3__1.html#ga33651bc4c0c36496d86038d95f39f0cd">More...</a><br /></td></tr>
<tr class="separator:ga33651bc4c0c36496d86038d95f39f0cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabfbfaddf9ab531ff85a1c4f9036631aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gabfbfaddf9ab531ff85a1c4f9036631aa">XUartLite_SelfTest</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:gabfbfaddf9ab531ff85a1c4f9036631aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runs a self-test on the device hardware.  <a href="group__uartlite__v3__1.html#gabfbfaddf9ab531ff85a1c4f9036631aa">More...</a><br /></td></tr>
<tr class="separator:gabfbfaddf9ab531ff85a1c4f9036631aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca08a21fa15779ce8dedd2ac9f25971e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gaca08a21fa15779ce8dedd2ac9f25971e">XUartLite_EnableInterrupt</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaca08a21fa15779ce8dedd2ac9f25971e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the UART interrupt such that an interrupt will occur when data is received or data has been transmitted.  <a href="group__uartlite__v3__1.html#gaca08a21fa15779ce8dedd2ac9f25971e">More...</a><br /></td></tr>
<tr class="separator:gaca08a21fa15779ce8dedd2ac9f25971e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa1b67ac0d2f5bf69ce6084ea49cef39"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#gaaa1b67ac0d2f5bf69ce6084ea49cef39">XUartLite_DisableInterrupt</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaaa1b67ac0d2f5bf69ce6084ea49cef39"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables the UART interrupt.  <a href="group__uartlite__v3__1.html#gaaa1b67ac0d2f5bf69ce6084ea49cef39">More...</a><br /></td></tr>
<tr class="separator:gaaa1b67ac0d2f5bf69ce6084ea49cef39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga312d1ce48b9e29e08ebb25d942b2ff51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga312d1ce48b9e29e08ebb25d942b2ff51">XUartLite_SetRecvHandler</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, <a class="el" href="group__uartlite__v3__1.html#ga516b36e319627a8a53a5b10b3f8fb62f">XUartLite_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="memdesc:ga312d1ce48b9e29e08ebb25d942b2ff51"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the handler that will be called when an event (interrupt) occurs in the driver.  <a href="group__uartlite__v3__1.html#ga312d1ce48b9e29e08ebb25d942b2ff51">More...</a><br /></td></tr>
<tr class="separator:ga312d1ce48b9e29e08ebb25d942b2ff51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga282cca48bbd4c1144c811681854fc780"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga282cca48bbd4c1144c811681854fc780">XUartLite_SetSendHandler</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr, <a class="el" href="group__uartlite__v3__1.html#ga516b36e319627a8a53a5b10b3f8fb62f">XUartLite_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="memdesc:ga282cca48bbd4c1144c811681854fc780"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the handler that will be called when an event (interrupt) occurs in the driver.  <a href="group__uartlite__v3__1.html#ga282cca48bbd4c1144c811681854fc780">More...</a><br /></td></tr>
<tr class="separator:ga282cca48bbd4c1144c811681854fc780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga399463f89d7b4e846a4a4089e9cd54fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartlite__v3__1.html#ga399463f89d7b4e846a4a4089e9cd54fb">XUartLite_InterruptHandler</a> (<a class="el" href="struct_x_uart_lite.html">XUartLite</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga399463f89d7b4e846a4a4089e9cd54fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the UART lite driver.  <a href="group__uartlite__v3__1.html#ga399463f89d7b4e846a4a4089e9cd54fb">More...</a><br /></td></tr>
<tr class="separator:ga399463f89d7b4e846a4a4089e9cd54fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
